package com.asdhawaii.ics111game.room;

/**
 * A list of the valid directions in which an entity may travel.
 * The documentation for the individual values contains the direction
 * (which given the names of the values should have been obvious to begin with)
 * and the hypothetical change to coordinates if using Cartesian coordinates while
 * viewing the map from above.  Thus the x-axis translates to left-right movement, 
 * the y-axis to up-down, and the z-axis to depth.
 *  
 * 
 * @author Branden Ogata
 *
 */

public enum Direction
{
  /**
   * North; [x][y+1][z].
   * 
   */
  NORTH,
  
  /**
   * Northeast; [x+1][y+1][z].
   * 
   */
  NORTHEAST,
  
  /**
   * East; [x+1][y][z].
   * 
   */
  EAST,
  
  /**
   * Southeast; [x+1][y-1][z].
   * 
   */
  SOUTHEAST,
  
  /**
   * South; [x][y-1][z].
   * 
   */
  SOUTH,
  
  /**
   * Southwest; [x-1][y-1][z].
   * 
   */
  SOUTHWEST,
  
  /**
   * West; [x-1][y][z].
   * 
   */
  WEST,
  
  /**
   * Northwest; [x-1][y+1][z].
   * 
   */
  NORTHWEST,
  
  /**
   * Up; [x][y][z+1].
   * 
   */
  UP,
  
  /**
   * Down; [x][y][z-1].
   * 
   */
  DOWN;
}
